home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / commodity / microtm102.lha / MicroTM / MicroTM.doc < prev    next >
Encoding:
Text File  |  1994-03-15  |  5.5 KB  |  169 lines
  1.  
  2.                               Micro ToolManager
  3.                                  Version 1.2
  4.                                   User DOC
  5.  
  6.  
  7.      BACKGROUND
  8.  
  9.      I  downloaded  program  called AutoAppMenu from the Aminet.  It was some
  10. sort  of  toolmenu  manager  and  it  was  very small.  But it didn't meet my
  11. requirements  in  many points - it was not commodity, programs could not have
  12. output,  you  could not run program by pressing a hotkey.  In general, it was
  13. very  not-customizable.  So I decided to write my own small toolmanager which
  14. would be able to do averything like big tool-managers.
  15.  
  16.  
  17.      ABOUT
  18.  
  19.      MictoTM  is  very  small  toolmenu  manager.  Provides running apps from
  20. WorkBench's  tool menu, by AppIcon or by pressing a hotkey.  Can pass args to
  21. app when ran from menu or icon.
  22.  
  23.  
  24.      PROGRAM CONFIGURATION
  25.  
  26.      Program  is  customized  by  a  configuration  file, which is by default
  27. "ENVARC:MicroTM.prefs".   You  can  change  the filename by the CFG tooltype.
  28. The file is organized to lines.  There is one application for every line (and
  29. vice versa), except empty lines, which are ignored. Line format is following:
  30.  
  31.      Position,Name,Menuitem,Icon,Execution string,hotkey
  32.  
  33.      If you don't want to specify e.g. hotkey, even need not to specify last
  34. comma:
  35.       Example of a separting item (w/out apostrophs): 'a,---------,'.
  36.  
  37.      POSITION:   Only  one  char  is  processed (none if this part is empty).
  38. This  field  controls "priority" of the item and is used for sorting items in
  39. menu.   Item(s) with the least priority is/are at the top.  Nothing means the
  40. least  priority.   You  will  probably  use numbers or letters, but all ASCII
  41. chars are allowed (except LF and NULL :-).
  42.  
  43.      NAME:  Name of application used as name for menuitem/icon.
  44.  
  45.      MENUITEM:   Whether or not create menuitem.  Only one char is processed.
  46. If is this part empty or char is not '-', menuitem is created.
  47.  
  48.      ICON:  Icon specification. Path and name of icon (WITHOUT '.info' !!!).
  49. The program is searching for icon in this order:
  50.  
  51.      -  Filename  in  icon  specification (if not empty or doesn't begin with
  52.         special char - see below)
  53.      -  Program  name  in execution string (if not disabled by special char -
  54.         - see below)
  55.      -  Default App Icon
  56.      -  Default Tool Icon
  57.  
  58.      Possible special chars:
  59.      If first char of the ICON part is '-', app will not have AppIcon.
  60.      If  this char is '"', program will have default icon.  (Either DefApp or
  61. DefTool if DefApp cannot be found.)
  62.  
  63.      EXECUTION  STRING:   Tells  which  program  to execute.  This string can
  64. contain following directives:
  65.  
  66.      %% - The '%' char will be inserted here
  67.      %a - One argument will be inserted here
  68.      %n - Name of item will be inserted here
  69.      %r - Remaining arguments will be inserted here
  70.  
  71.      If  you tell program to insert argument(s) and none remain, nothing will
  72. be  inserted.   Program  does  not  insert spaces neither after nor before an
  73. argument/name  except  when  inserting  remaining  arguments.   These will be
  74. separated by spaces.
  75.  
  76.      Example: (without apostrophs): ',UnLha,,,c:lha x %a ram:una/'
  77.  
  78.      HOTKEY: This is standart commodity hotkey specification. E.g., CTRL
  79. LCOMMAND HELP.
  80.  
  81.  
  82.      TOOLTYPES
  83.  
  84.      Program recognizes two tooltypes:
  85.  
  86.      CFG -  Specifies configuration files.
  87.  
  88.      CON  -  Specification of console window.  This is only first part of the
  89. console  name.   When starting program, it's name and the AUTO potion will be
  90. added to it.  Default is 'CON:////'.
  91.  
  92.  
  93.      INSTALATION
  94.  
  95.      Just  copy  the  program and icon to your WBStartup drawer. Then create
  96. your own configuration file.
  97.  
  98.  
  99.      CONTROLLING THE PROGRAM
  100.  
  101.      Disable/Enable works. When disabled, all menuitems and appicons are
  102. removed and hotkeys are inactive
  103.  
  104.      When  pressed  the "Show Interface" gadget, config file is re-loaded, so
  105. you need not to quit and re-run the program after a change in the file.
  106.  
  107.  
  108.      ERRORS
  109.  
  110.      Program has no error messages, just beeps when something went wrong.  It
  111. can be caused by:
  112.  
  113.      When starting:
  114.      - Cannot find config file
  115.      - Another copy already running
  116.      - Totally out of memory etc.
  117.  
  118.      When removing:
  119.      - All launched tasks didn't return yet
  120.  
  121.  
  122.      BUGS
  123.  
  124.      When starting from CLI, no argument parsing is done.  This is not a bug,
  125. the  program  is designed to be run from WB.  Possibility of running from cli
  126. is implemented for debug purposes only.
  127.  
  128.      No arguments are passed when running by pressing a hotkey.  It's because
  129. I don't know how to ask WB to send me a list of selected icons.
  130.  
  131.      When  the  ICON part is empty and program to be executed contains space,
  132. program will be unable to find it's icon.
  133.  
  134.  
  135.      PLANS FOR FUTURE
  136.  
  137.      - Try to do argument passing by hotkey
  138.  
  139.      - Add notification on the config file
  140.  
  141.      - Repair bugs
  142.  
  143.      - Keep it small
  144.  
  145.  
  146.      LEGAL STUFF
  147.  
  148.      This  product  is  freely  distributable  as  long  as  the archive goes
  149. unchanged.  It can be included in any non-profit shareware or similar program
  150. package without specific permission from the author.
  151.  
  152.      This  program  is  provided  "AS  IS"  i.e.,  the  author  (me)  is  not
  153. responsible  for  any hardware, software, physical or psychological damage or
  154. data loss caused as a consequence of using this program.
  155.  
  156.  
  157.      AUTHOR
  158.  
  159.      Feel  free to send comments, bug reports, greetings, hardware (no nails,
  160. please !-), cars, gold, dynamite, etc.  to:
  161.  
  162.      E-Mail: lemming@k332.feld.cvut.cz
  163.  
  164.      S-Mail: Michal Kara
  165.              Krosenska 543
  166.              Praha 8
  167.              181 00
  168.              Czech Republic
  169.